d3plus-viz

d3plus-viz

Abstract ES6 class that drives d3plus visualizations.

Installing

If you use NPM, npm install d3plus-viz. Otherwise, download the latest release. The released bundle supports AMD, CommonJS, and vanilla environments. Create a custom bundle using Rollup or your preferred bundler. You can also load directly from d3plus.org:

<script src="https://d3plus.org/js/d3plus-viz.v0.5.full.min.js"></script>

API Reference

Viz ⇐ BaseClass

Kind: global class
Extends: BaseClass

• Viz ⇐ BaseClass
  • new Viz()
  • .render([callback]) ↩︎
  • .active([value]) ↩︎
  • .aggs([value]) ↩︎
  • .backConfig([value]) ↩︎
  • .data([data]) ↩︎
  • .depth([value]) ↩︎
  • .discrete([value]) ↩︎
  • .duration([ms]) ↩︎
  • .filter([value]) ↩︎
  • .groupBy([value]) ↩︎
  • .height([value]) ↩︎
  • .hover([value]) ↩︎
  • .label([value]) ↩︎
  • .legend([value]) ↩︎
  • .legendConfig([value]) ↩︎
  • .locale([value]) ↩︎
  • .select([selector]) ↩︎
  • .shape([value]) ↩︎
  • .shapeConfig([value]) ↩︎
  • .time([value]) ↩︎
  • .timeFilter([value]) ↩︎
  • .timeline([value]) ↩︎
  • .timelineConfig([value]) ↩︎
  • .title([value]) ↩︎
  • .titleConfig([value]) ↩︎
  • .tooltip([value]) ↩︎
  • .tooltipConfig([value]) ↩︎
  • .total([value]) ↩︎
  • .totalConfig([value]) ↩︎
  • .width([value]) ↩︎

new Viz()

Creates an x/y plot based on an array of data. If data is specified, immediately draws the tree map based on the specified array and returns the current class instance. If data is not specified on instantiation, it can be passed/updated after instantiation using the data method. See this example for help getting started using the treemap generator.

Viz.render([callback]) ↩︎

Draws the visualization given the specified configuration.

Kind: static method of Viz
Chainable

Param	Type	Description
[callback]	function	An optional callback function that, if passed, will be called after animation is complete.

Viz.active([value]) ↩︎

If value is specified, sets the active method to the specified function and returns the current class instance. If value is not specified, returns the current active method.

Kind: static method of Viz
Chainable

Param	Type
[value]	function

Viz.aggs([value]) ↩︎

If value is specified, sets the aggregation method for each key in the object and returns the current class instance. If value is not specified, returns the current defined aggregation methods.

Kind: static method of Viz
Chainable

Param	Type
[value]	Object

Viz.backConfig([value]) ↩︎

If value is specified, sets the config method for the back button and returns the current class instance. If value is not specified, returns the current back button configuration.

Kind: static method of Viz
Chainable

Param	Type
[value]	Object

Viz.data([data]) ↩︎

If data is specified, sets the data array to the specified array and returns the current class instance. If data is not specified, returns the current data array.

Kind: static method of Viz
Chainable

Param	Type	Default
[data]	Array	[]

Viz.depth([value]) ↩︎

If value is specified, sets the depth to the specified number and returns the current class instance. The value should correspond with an index in the groupBy array. If value is not specified, returns the current depth.

Kind: static method of Viz
Chainable

Param	Type
[value]	Number

Viz.discrete([value]) ↩︎

If value is specified, sets the discrete accessor to the specified method name (usually an axis) and returns the current class instance. If value is not specified, returns the current discrete method.

Kind: static method of Viz
Chainable

Param	Type
[value]	String

Viz.duration([ms]) ↩︎

If ms is specified, sets the animation duration to the specified number and returns the current class instance. If ms is not specified, returns the current animation duration.

Kind: static method of Viz
Chainable

Param	Type	Default
[ms]	Number	600

Viz.filter([value]) ↩︎

If value is specified, sets the filter to the specified function and returns the current class instance. If value is not specified, returns the current filter.

Kind: static method of Viz
Chainable

Param	Type
[value]	function

Viz.groupBy([value]) ↩︎

If value is specified, sets the group accessor(s) to the specified string, function, or array of values and returns the current class instance. If value is not specified, returns the current group accessor.

Kind: static method of Viz
Chainable

Param	Type
[value]	String | function | Array

Example

function value(d) {
  return d.id;
}

Viz.height([value]) ↩︎

If value is specified, sets the overall height to the specified number and returns the current class instance. If value is not specified, returns the current overall height.

Kind: static method of Viz
Chainable

Param	Type	Default
[value]	Number	window.innerHeight

Viz.hover([value]) ↩︎

If value is specified, sets the hover method to the specified function and returns the current class instance. If value is not specified, returns the current hover method.

Kind: static method of Viz
Chainable

Param	Type
[value]	function

Viz.label([value]) ↩︎

If value is specified, sets the label accessor to the specified function or string and returns the current class instance. If value is not specified, returns the current text accessor, which is undefined by default.

Kind: static method of Viz
Chainable

Param	Type
[value]	function | String

Viz.legend([value]) ↩︎

If value is specified, toggles the legend based on the specified boolean and returns the current class instance. If value is not specified, returns the current value.

Kind: static method of Viz
Chainable

Param	Type	Default
[value]	Boolean	true

Viz.legendConfig([value]) ↩︎

If value is specified, the object is passed to the legend's config method. If value is not specified, returns the current legend config.

Kind: static method of Viz
Chainable

Param	Type
[value]	Object

Viz.locale([value]) ↩︎

If value is specified, sets the locale to the specified string and returns the current class instance. If value is not specified, returns the current locale.

Kind: static method of Viz
Chainable

Param	Type	Default
[value]	String	"en-US"

Viz.select([selector]) ↩︎

If selector is specified, sets the SVG container element to the specified d3 selector or DOM element and returns the current class instance. If selector is not specified, returns the current SVG container element, which is undefined by default.

Kind: static method of Viz
Chainable

Param	Type
[selector]	String | HTMLElement

Viz.shape([value]) ↩︎

If value is specified, sets the shape accessor to the specified function or number and returns the current class instance. If value is not specified, returns the current shape accessor.

Kind: static method of Viz
Chainable

Param	Type
[value]	function | String

Viz.shapeConfig([value]) ↩︎

If value is specified, sets the config method for each shape and returns the current class instance. If value is not specified, returns the current shape configuration.

Kind: static method of Viz
Chainable

Param	Type
[value]	Object

Viz.time([value]) ↩︎

If value is specified, sets the time accessor to the specified function or string and returns the current class instance. If value is not specified, returns the current time accessor. The time values that are returned should be valid Date objects, 4-digit year values, or strings that can be parsed into javascript Date objects (click here for valid string formats).

Kind: static method of Viz
Chainable

Param	Type
[value]	function | String

Viz.timeFilter([value]) ↩︎

If value is specified, sets the time filter to the specified function and returns the current class instance. If value is not specified, returns the current time filter.

Kind: static method of Viz
Chainable

Param	Type
[value]	function

Viz.timeline([value]) ↩︎

If value is specified, toggles the timeline based on the specified boolean and returns the current class instance. If value is not specified, returns the current timeline visibility.

Kind: static method of Viz
Chainable

Param	Type	Default
[value]	Boolean	true

Viz.timelineConfig([value]) ↩︎

If value is specified, sets the config method for the timeline and returns the current class instance. If value is not specified, returns the current timeline configuration.

Kind: static method of Viz
Chainable

Param	Type
[value]	Object

Viz.title([value]) ↩︎

If value is specified, sets the title accessor to the specified function or string and returns the current class instance. If value is not specified, returns the current title accessor.

Kind: static method of Viz
Chainable

Param	Type
[value]	function | String

Viz.titleConfig([value]) ↩︎

If value is specified, sets the config method for the title and returns the current class instance. If value is not specified, returns the current title configuration.

Kind: static method of Viz
Chainable

Param	Type
[value]	Object

Viz.tooltip([value]) ↩︎

If value is specified, toggles the tooltip based on the specified boolean and returns the current class instance. If value is not specified, returns the current tooltip visibility.

Kind: static method of Viz
Chainable

Param	Type	Default
[value]	Boolean	true

Viz.tooltipConfig([value]) ↩︎

If value is specified, sets the config method for the tooltip and returns the current class instance. If value is not specified, returns the current tooltip configuration.

Kind: static method of Viz
Chainable

Param	Type
[value]	Object

Viz.total([value]) ↩︎

If value is specified, sets the total accessor to the specified function or string and returns the current class instance. If value is not specified, returns the current total accessor.

Kind: static method of Viz
Chainable

Param	Type
[value]	Boolean | function | String

Viz.totalConfig([value]) ↩︎

If value is specified, sets the config method for the total and returns the current class instance. If value is not specified, returns the current total configuration.

Kind: static method of Viz
Chainable

Param	Type
[value]	Object

Viz.width([value]) ↩︎

If value is specified, sets the overallwidth to the specified number and returns the current class instance. If value is not specified, returns the current overall width.

Kind: static method of Viz
Chainable

Param	Type	Default
[value]	Number	window.innerWidth

_{Documentation generated on Tue, 20 Dec 2016 20:14:25 GMT}